Skip to content

Update navigate-with-search-params.md #5894

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Update navigate-with-search-params.md #5894

wants to merge 1 commit into from
+1 −1

Conversation

@EzekielEnns
Copy link

@EzekielEnns EzekielEnns commented Nov 18, 2025 •
edited by coderabbitai bot
Loading

link was wrong lol

Summary by CodeRabbit

  • Documentation
    • Fixed a navigation link in the search parameters guide to ensure proper documentation cross-referencing.

@github-actions github-actions bot added the documentation Everything documentation related label Nov 18, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 18, 2025 •
edited
Loading

Walkthrough

Updated a prerequisite documentation link from a parent directory reference to a current directory reference in the React router navigation guide. The change corrects the relative path from ../setup-basic-search-params.md to ./setup-basic-search-params.md without affecting functionality.

Changes

Cohort / File(s) Summary
Documentation link fix
docs/router/framework/react/how-to/navigate-with-search-params.md		 Updated relative link path in Prerequisites section from parent directory reference to current directory reference

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

documentation

Poem

🐰 A link was broken, path went astray,
From parent's home, to here it comes to play,
One dot, one slash—the rabbit fixed today,
Now readers hop through docs the proper way! 📚✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and generic, using 'Update' without specifying what was actually changed or why it matters. Consider a more descriptive title like 'Fix relative path in navigate-with-search-params prerequisites link' that clarifies the specific change being made.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f830dff and 66d8d3e.

📒 Files selected for processing (1)
  • docs/router/framework/react/how-to/navigate-with-search-params.md (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-10-14T18:59:33.990Z 
Learnt from: FatahChan
Repo: TanStack/router PR: 5475
File: e2e/react-start/basic-prerendering/src/routes/redirect/$target/via-beforeLoad.tsx:8-0
Timestamp: 2025-10-14T18:59:33.990Z
Learning: In TanStack Router e2e test files, when a route parameter is validated at the route level (e.g., using zod in validateSearch or param validation), switch statements on that parameter do not require a default case, as the validation ensures only expected values will reach the switch.

Applied to files:

  • docs/router/framework/react/how-to/navigate-with-search-params.md
🔇 Additional comments (1)
docs/router/framework/react/how-to/navigate-with-search-params.md (1)

7-7: Verify the new link path exists and check consistency with other relative paths in the file.

The change updates the Prerequisites link from a parent-directory reference to a same-directory reference. However, lines 336–337 still use ../ for similar guide links, which suggests a potential inconsistency in path resolution across the file.

Please verify:

  1. That ./setup-basic-search-params.md actually exists at the same directory level (docs/router/framework/react/how-to/)
  2. That the other guide links at lines 336–337 (../validate-search-params.md and ../arrays-objects-dates-search-params.md) are correct
  3. Whether all guides should use consistent relative path patterns (all ./ or all ../ depending on where they're actually located)

Warning

Review ran into problems

🔥 Problems

Git: Failed to clone repository. Please run the @coderabbitai full review command to re-trigger a full review. If the issue persists, set path_filters to include or exclude specific files.

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@EzekielEnns EzekielEnns marked this pull request as draft November 18, 2025 20:48
@EzekielEnns
Copy link
Author

EzekielEnns commented Nov 18, 2025

damn alot more issues here will will fix tn

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Everything documentation related

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@EzekielEnns